<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span>package org.apache.commons.io;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.io.File;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>/**<a name="line.21"></a>
<span class="sourceLineNo">022</span> * Keeps track of files awaiting deletion, and deletes them when an associated<a name="line.22"></a>
<span class="sourceLineNo">023</span> * marker object is reclaimed by the garbage collector.<a name="line.23"></a>
<span class="sourceLineNo">024</span> * &lt;p&gt;<a name="line.24"></a>
<span class="sourceLineNo">025</span> * This utility creates a background thread to handle file deletion.<a name="line.25"></a>
<span class="sourceLineNo">026</span> * Each file to be deleted is registered with a handler object.<a name="line.26"></a>
<span class="sourceLineNo">027</span> * When the handler object is garbage collected, the file is deleted.<a name="line.27"></a>
<span class="sourceLineNo">028</span> * &lt;p&gt;<a name="line.28"></a>
<span class="sourceLineNo">029</span> * In an environment with multiple class loaders (a servlet container, for<a name="line.29"></a>
<span class="sourceLineNo">030</span> * example), you should consider stopping the background thread if it is no<a name="line.30"></a>
<span class="sourceLineNo">031</span> * longer needed. This is done by invoking the method<a name="line.31"></a>
<span class="sourceLineNo">032</span> * {@link #exitWhenFinished}, typically in<a name="line.32"></a>
<span class="sourceLineNo">033</span> * {@code javax.servlet.ServletContextListener.contextDestroyed(javax.servlet.ServletContextEvent)} or similar.<a name="line.33"></a>
<span class="sourceLineNo">034</span> *<a name="line.34"></a>
<span class="sourceLineNo">035</span> * @deprecated Use {@link FileCleaningTracker}<a name="line.35"></a>
<span class="sourceLineNo">036</span> */<a name="line.36"></a>
<span class="sourceLineNo">037</span>@Deprecated<a name="line.37"></a>
<span class="sourceLineNo">038</span>public class FileCleaner {<a name="line.38"></a>
<span class="sourceLineNo">039</span>    /**<a name="line.39"></a>
<span class="sourceLineNo">040</span>     * The instance to use for the deprecated, static methods.<a name="line.40"></a>
<span class="sourceLineNo">041</span>     */<a name="line.41"></a>
<span class="sourceLineNo">042</span>    static final FileCleaningTracker theInstance = new FileCleaningTracker();<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span>    /**<a name="line.44"></a>
<span class="sourceLineNo">045</span>     * Track the specified file, using the provided marker, deleting the file<a name="line.45"></a>
<span class="sourceLineNo">046</span>     * when the marker instance is garbage collected.<a name="line.46"></a>
<span class="sourceLineNo">047</span>     * The {@link FileDeleteStrategy#NORMAL normal} deletion strategy will be used.<a name="line.47"></a>
<span class="sourceLineNo">048</span>     *<a name="line.48"></a>
<span class="sourceLineNo">049</span>     * @param file  the file to be tracked, not null<a name="line.49"></a>
<span class="sourceLineNo">050</span>     * @param marker  the marker object used to track the file, not null<a name="line.50"></a>
<span class="sourceLineNo">051</span>     * @throws NullPointerException if the file is null<a name="line.51"></a>
<span class="sourceLineNo">052</span>     * @deprecated Use {@link FileCleaningTracker#track(File, Object)}.<a name="line.52"></a>
<span class="sourceLineNo">053</span>     */<a name="line.53"></a>
<span class="sourceLineNo">054</span>    @Deprecated<a name="line.54"></a>
<span class="sourceLineNo">055</span>    public static void track(final File file, final Object marker) {<a name="line.55"></a>
<span class="sourceLineNo">056</span>        theInstance.track(file, marker);<a name="line.56"></a>
<span class="sourceLineNo">057</span>    }<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span>    /**<a name="line.59"></a>
<span class="sourceLineNo">060</span>     * Track the specified file, using the provided marker, deleting the file<a name="line.60"></a>
<span class="sourceLineNo">061</span>     * when the marker instance is garbage collected.<a name="line.61"></a>
<span class="sourceLineNo">062</span>     * The specified deletion strategy is used.<a name="line.62"></a>
<span class="sourceLineNo">063</span>     *<a name="line.63"></a>
<span class="sourceLineNo">064</span>     * @param file  the file to be tracked, not null<a name="line.64"></a>
<span class="sourceLineNo">065</span>     * @param marker  the marker object used to track the file, not null<a name="line.65"></a>
<span class="sourceLineNo">066</span>     * @param deleteStrategy  the strategy to delete the file, null means normal<a name="line.66"></a>
<span class="sourceLineNo">067</span>     * @throws NullPointerException if the file is null<a name="line.67"></a>
<span class="sourceLineNo">068</span>     * @deprecated Use {@link FileCleaningTracker#track(File, Object, FileDeleteStrategy)}.<a name="line.68"></a>
<span class="sourceLineNo">069</span>     */<a name="line.69"></a>
<span class="sourceLineNo">070</span>    @Deprecated<a name="line.70"></a>
<span class="sourceLineNo">071</span>    public static void track(final File file, final Object marker, final FileDeleteStrategy deleteStrategy) {<a name="line.71"></a>
<span class="sourceLineNo">072</span>        theInstance.track(file, marker, deleteStrategy);<a name="line.72"></a>
<span class="sourceLineNo">073</span>    }<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span>    /**<a name="line.75"></a>
<span class="sourceLineNo">076</span>     * Track the specified file, using the provided marker, deleting the file<a name="line.76"></a>
<span class="sourceLineNo">077</span>     * when the marker instance is garbage collected.<a name="line.77"></a>
<span class="sourceLineNo">078</span>     * The {@link FileDeleteStrategy#NORMAL normal} deletion strategy will be used.<a name="line.78"></a>
<span class="sourceLineNo">079</span>     *<a name="line.79"></a>
<span class="sourceLineNo">080</span>     * @param path  the full path to the file to be tracked, not null<a name="line.80"></a>
<span class="sourceLineNo">081</span>     * @param marker  the marker object used to track the file, not null<a name="line.81"></a>
<span class="sourceLineNo">082</span>     * @throws NullPointerException if the path is null<a name="line.82"></a>
<span class="sourceLineNo">083</span>     * @deprecated Use {@link FileCleaningTracker#track(String, Object)}.<a name="line.83"></a>
<span class="sourceLineNo">084</span>     */<a name="line.84"></a>
<span class="sourceLineNo">085</span>    @Deprecated<a name="line.85"></a>
<span class="sourceLineNo">086</span>    public static void track(final String path, final Object marker) {<a name="line.86"></a>
<span class="sourceLineNo">087</span>        theInstance.track(path, marker);<a name="line.87"></a>
<span class="sourceLineNo">088</span>    }<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span>    /**<a name="line.90"></a>
<span class="sourceLineNo">091</span>     * Track the specified file, using the provided marker, deleting the file<a name="line.91"></a>
<span class="sourceLineNo">092</span>     * when the marker instance is garbage collected.<a name="line.92"></a>
<span class="sourceLineNo">093</span>     * The specified deletion strategy is used.<a name="line.93"></a>
<span class="sourceLineNo">094</span>     *<a name="line.94"></a>
<span class="sourceLineNo">095</span>     * @param path  the full path to the file to be tracked, not null<a name="line.95"></a>
<span class="sourceLineNo">096</span>     * @param marker  the marker object used to track the file, not null<a name="line.96"></a>
<span class="sourceLineNo">097</span>     * @param deleteStrategy  the strategy to delete the file, null means normal<a name="line.97"></a>
<span class="sourceLineNo">098</span>     * @throws NullPointerException if the path is null<a name="line.98"></a>
<span class="sourceLineNo">099</span>     * @deprecated Use {@link FileCleaningTracker#track(String, Object, FileDeleteStrategy)}.<a name="line.99"></a>
<span class="sourceLineNo">100</span>     */<a name="line.100"></a>
<span class="sourceLineNo">101</span>    @Deprecated<a name="line.101"></a>
<span class="sourceLineNo">102</span>    public static void track(final String path, final Object marker, final FileDeleteStrategy deleteStrategy) {<a name="line.102"></a>
<span class="sourceLineNo">103</span>        theInstance.track(path, marker, deleteStrategy);<a name="line.103"></a>
<span class="sourceLineNo">104</span>    }<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span>    /**<a name="line.106"></a>
<span class="sourceLineNo">107</span>     * Retrieve the number of files currently being tracked, and therefore<a name="line.107"></a>
<span class="sourceLineNo">108</span>     * awaiting deletion.<a name="line.108"></a>
<span class="sourceLineNo">109</span>     *<a name="line.109"></a>
<span class="sourceLineNo">110</span>     * @return the number of files being tracked<a name="line.110"></a>
<span class="sourceLineNo">111</span>     * @deprecated Use {@link FileCleaningTracker#getTrackCount()}.<a name="line.111"></a>
<span class="sourceLineNo">112</span>     */<a name="line.112"></a>
<span class="sourceLineNo">113</span>    @Deprecated<a name="line.113"></a>
<span class="sourceLineNo">114</span>    public static int getTrackCount() {<a name="line.114"></a>
<span class="sourceLineNo">115</span>        return theInstance.getTrackCount();<a name="line.115"></a>
<span class="sourceLineNo">116</span>    }<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span>    /**<a name="line.118"></a>
<span class="sourceLineNo">119</span>     * Call this method to cause the file cleaner thread to terminate when<a name="line.119"></a>
<span class="sourceLineNo">120</span>     * there are no more objects being tracked for deletion.<a name="line.120"></a>
<span class="sourceLineNo">121</span>     * &lt;p&gt;<a name="line.121"></a>
<span class="sourceLineNo">122</span>     * In a simple environment, you don't need this method as the file cleaner<a name="line.122"></a>
<span class="sourceLineNo">123</span>     * thread will simply exit when the JVM exits. In a more complex environment,<a name="line.123"></a>
<span class="sourceLineNo">124</span>     * with multiple class loaders (such as an application server), you should be<a name="line.124"></a>
<span class="sourceLineNo">125</span>     * aware that the file cleaner thread will continue running even if the class<a name="line.125"></a>
<span class="sourceLineNo">126</span>     * loader it was started from terminates. This can constitute a memory leak.<a name="line.126"></a>
<span class="sourceLineNo">127</span>     * &lt;p&gt;<a name="line.127"></a>
<span class="sourceLineNo">128</span>     * For example, suppose that you have developed a web application, which<a name="line.128"></a>
<span class="sourceLineNo">129</span>     * contains the commons-io jar file in your WEB-INF/lib directory. In other<a name="line.129"></a>
<span class="sourceLineNo">130</span>     * words, the FileCleaner class is loaded through the class loader of your<a name="line.130"></a>
<span class="sourceLineNo">131</span>     * web application. If the web application is terminated, but the servlet<a name="line.131"></a>
<span class="sourceLineNo">132</span>     * container is still running, then the file cleaner thread will still exist,<a name="line.132"></a>
<span class="sourceLineNo">133</span>     * posing a memory leak.<a name="line.133"></a>
<span class="sourceLineNo">134</span>     * &lt;p&gt;<a name="line.134"></a>
<span class="sourceLineNo">135</span>     * This method allows the thread to be terminated. Simply call this method<a name="line.135"></a>
<span class="sourceLineNo">136</span>     * in the resource cleanup code, such as<a name="line.136"></a>
<span class="sourceLineNo">137</span>     * {@code javax.servlet.ServletContextListener.contextDestroyed(javax.servlet.ServletContextEvent)}.<a name="line.137"></a>
<span class="sourceLineNo">138</span>     * One called, no new objects can be tracked by the file cleaner.<a name="line.138"></a>
<span class="sourceLineNo">139</span>     * @deprecated Use {@link FileCleaningTracker#exitWhenFinished()}.<a name="line.139"></a>
<span class="sourceLineNo">140</span>     */<a name="line.140"></a>
<span class="sourceLineNo">141</span>    @Deprecated<a name="line.141"></a>
<span class="sourceLineNo">142</span>    public static synchronized void exitWhenFinished() {<a name="line.142"></a>
<span class="sourceLineNo">143</span>        theInstance.exitWhenFinished();<a name="line.143"></a>
<span class="sourceLineNo">144</span>    }<a name="line.144"></a>
<span class="sourceLineNo">145</span><a name="line.145"></a>
<span class="sourceLineNo">146</span>    /**<a name="line.146"></a>
<span class="sourceLineNo">147</span>     * Returns the singleton instance, which is used by the deprecated, static methods.<a name="line.147"></a>
<span class="sourceLineNo">148</span>     * This is mainly useful for code, which wants to support the new<a name="line.148"></a>
<span class="sourceLineNo">149</span>     * {@link FileCleaningTracker} class while maintain compatibility with the<a name="line.149"></a>
<span class="sourceLineNo">150</span>     * deprecated {@link FileCleaner}.<a name="line.150"></a>
<span class="sourceLineNo">151</span>     *<a name="line.151"></a>
<span class="sourceLineNo">152</span>     * @return the singleton instance<a name="line.152"></a>
<span class="sourceLineNo">153</span>     */<a name="line.153"></a>
<span class="sourceLineNo">154</span>    public static FileCleaningTracker getInstance() {<a name="line.154"></a>
<span class="sourceLineNo">155</span>        return theInstance;<a name="line.155"></a>
<span class="sourceLineNo">156</span>    }<a name="line.156"></a>
<span class="sourceLineNo">157</span>}<a name="line.157"></a>




























































</pre>
</div>
</body>
</html>
